<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.job_format_reader.JobReader</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        <a href="simvoc.core.job_format_reader-module.html">Module&nbsp;job_format_reader</a> ::
        Class&nbsp;JobReader
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class JobReader</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_simvoc_c_15" name="uml_class_diagram_for_simvoc_c_15">
<area shape="rect" id="node28" href="simvoc.core.job_format_reader.JobReader-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,377,327,396"/>
<area shape="rect" id="node28" href="simvoc.core.job_format_reader.JobReader-class.html#submit_job" title="Submits a job to the grid at the current simulated time" alt="" coords="17,396,327,415"/>
<area shape="rect" id="node28" href="simvoc.core.job_format_reader.JobReader-class.html#h_colon" title="Parse handler for job definitions." alt="" coords="17,415,327,433"/>
<area shape="rect" id="node1" href="simvoc.core.job_format_reader.JobReader-class.html" title="Mechanism for reading job trace files, creating Job objects from the traces, and submitting the resulting jobs to the grid." alt="" coords="5,345,339,439"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#add_handler" title="Adds a parse handler to support new commands." alt="" coords="72,39,271,57"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#add_trigger" title="Adds a new parse trigger as a simulator event scheduled for a time not in &#160;the past." alt="" coords="72,57,271,76"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#error" title="Uniform mechanism for producing error messages (ReaderExceptions) with &#160;filename and line number information." alt="" coords="72,76,271,95"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#get_epoch" title="Returns: &#160;epoch value found in the input file (defaults to zero if not present)" alt="" coords="72,95,271,113"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#h_clock" title="Parse handler for clock lines." alt="" coords="72,113,271,132"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#h_epoch" title="Parse handler for the epoch statement, which allows multiple input files &#160;with normalized times to be used in the same simulation." alt="" coords="72,132,271,151"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#h_format" title="Parse handler for the &quot;format&quot; command." alt="" coords="72,151,271,169"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#h_meta" title="Parse handler for metadata." alt="" coords="72,169,271,188"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#h_version" title="Parse handler for file version number." alt="" coords="72,188,271,207"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#in_clock_block" title="Returns: &#160;True iff at least one clock line has been parsed, allowing routines to &#160;ensure that the current command is inside a clock block" alt="" coords="72,207,271,225"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#parse" title="Main parser loop, invoked by the trigger() method." alt="" coords="72,225,271,244"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#scan" title="Implements the scanner portion of the common format reader." alt="" coords="72,244,271,263"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#set_normalization" title="Sets the offset according to the specified normalized time value." alt="" coords="72,263,271,281"/>
<area shape="rect" id="node29" href="simvoc.core.common_reader.CommonReader-class.html#warning" title="Uniform mechanism for raising a warning when conditions exist in the input &#160;file that do not necessarily constitute an error." alt="" coords="72,300,271,319"/>
<area shape="rect" id="node2" href="simvoc.core.common_reader.CommonReader-class.html" title="Implements a common scanner and parser for the simulator input formats written by simvoc.input.common_writer." alt="" coords="60,6,281,325"/>
</map>
  <img src="uml_class_diagram_for_simvoc_c_15.gif" alt='' usemap="#uml_class_diagram_for_simvoc_c_15" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Mechanism for reading job trace files, creating Job objects from the 
  traces, and submitting the resulting jobs to the grid. An optional job 
  modification function may be used, which will be called just before 
  submitting the job to the grid. This function must take two arguments: 
  the site name to which the job is to be submitted, and the Job object 
  itself. The function must return a string containing the site name to 
  which the job is to be submitted, or None if the job is to be 
  discarded.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_format_reader.JobReader-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">filename</span>,
        <span class="summary-sig-arg">fh</span>,
        <span class="summary-sig-arg">simobj</span>,
        <span class="summary-sig-arg">grid</span>,
        <span class="summary-sig-arg">modfn</span>=<span class="summary-sig-default">None</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_format_reader.JobReader-class.html#submit_job" class="summary-sig-name">submit_job</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">site_name</span>,
        <span class="summary-sig-arg">job</span>)</span><br />
      Submits a job to the grid at the current simulated time</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.submit_job">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_format_reader.JobReader-class.html#h_colon" class="summary-sig-name">h_colon</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for job definitions.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.h_colon">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#add_handler" class="summary-sig-name">add_handler</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cmd</span>,
        <span class="summary-sig-arg">handler</span>)</span><br />
      Adds a parse handler to support new commands.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.add_handler">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#add_trigger" class="summary-sig-name">add_trigger</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>)</span><br />
      Adds a new parse trigger as a simulator event scheduled for a time 
      not in the past.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.add_trigger">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#error" class="summary-sig-name">error</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">msg</span>)</span><br />
      Uniform mechanism for producing error messages (ReaderExceptions) 
      with filename and line number information.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.error">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">number</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#get_epoch" class="summary-sig-name">get_epoch</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns:
      epoch value found in the input file (defaults to zero if not present)
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.get_epoch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#h_clock" class="summary-sig-name">h_clock</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for clock lines.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.h_clock">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#h_epoch" class="summary-sig-name">h_epoch</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for the epoch statement, which allows multiple input 
      files with normalized times to be used in the same simulation.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.h_epoch">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#h_format" class="summary-sig-name">h_format</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for the &quot;format&quot; command.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.h_format">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#h_meta" class="summary-sig-name">h_meta</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for metadata.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.h_meta">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#h_version" class="summary-sig-name">h_version</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Parse handler for file version number.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.h_version">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#in_clock_block" class="summary-sig-name">in_clock_block</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns:
      True iff at least one clock line has been parsed, allowing routines 
      to ensure that the current command is inside a clock block
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.in_clock_block">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Main parser loop, invoked by the trigger() method.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.parse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">bool</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#scan" class="summary-sig-name">scan</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Implements the scanner portion of the common format reader.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.scan">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#set_normalization" class="summary-sig-name">set_normalization</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">normtime</span>)</span><br />
      Sets the offset according to the specified normalized time value.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.set_normalization">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#set_offset" class="summary-sig-name">set_offset</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset</span>)</span><br />
      Sets the clock block time offset, used in cases where multiple input 
      files with normalized times are used in the same simulation (see the 
      set_normalization() method).
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.set_offset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#trigger" class="summary-sig-name">trigger</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">simobj</span>)</span><br />
      Parse trigger: a simulator-aware function that invokes the parser to 
      handle the next clock block.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.trigger">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.common_reader.CommonReader-class.html#warning" class="summary-sig-name">warning</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">msg</span>)</span><br />
      Uniform mechanism for raising a warning when conditions exist in the 
      input file that do not necessarily constitute an error.
      <em>(Inherited from <a href="simvoc.core.common_reader.CommonReader-class.html">simvoc.core.common_reader.CommonReader</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.common_reader-pysrc.html#CommonReader.warning">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">filename</span>,
        <span class="sig-arg">fh</span>,
        <span class="sig-arg">simobj</span>,
        <span class="sig-arg">grid</span>,
        <span class="sig-arg">modfn</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>filename</code></strong> (str) - Name of open job file</li>
        <li><strong class="pname"><code>fh</code></strong> - Handle to open job file (r mode)</li>
        <li><strong class="pname"><code>simobj</code></strong> - Reference to the simulator instance</li>
        <li><strong class="pname"><code>grid</code></strong> - Grid object to which jobs are submitted</li>
        <li><strong class="pname"><code>modfn</code></strong> - Optional function to be called just before job submission</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="submit_job"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">submit_job</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">site_name</span>,
        <span class="sig-arg">job</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.submit_job">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Submits a job to the grid at the current simulated time</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>site_name</code></strong> (str) - Name of site to which job is to be submitted</li>
        <li><strong class="pname"><code>job</code></strong> - Job to submit</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="h_colon"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">h_colon</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_format_reader-pysrc.html#JobReader.h_colon">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Parse handler for job definitions.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>True</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:31 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
